docs: Convert resources section to markdown
authorMatthias Clasen <mclasen@redhat.com>
Sun, 24 May 2020 15:07:45 +0000 (11:07 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 25 May 2020 20:11:18 +0000 (16:11 -0400)
docs/reference/gtk/meson.build
docs/reference/gtk/resources.md [new file with mode: 0644]
docs/reference/gtk/resources.xml [deleted file]

index 9f7ac480d463853adda656cca7468da30b65048a..6c2170a115d7d2792719c632a5da9739b4ddae47 100644 (file)
@@ -353,7 +353,6 @@ content_files = [
   'gtk4-widget-factory.xml',
   'overview.xml',
   'question_index.xml',
-  'resources.xml',
   'text_widget.xml',
   'tree_widget.xml',
   'visual_index.xml',
@@ -371,8 +370,9 @@ expand_content_md_files = [
   'osx.md',
   'wayland.md',
   'windows.md',
-  'x11.md',
+: 'x11.md',
   'getting_started.md',
+  'resources.md',
   'building.md',
   'compiling.md',
   'running.md',
diff --git a/docs/reference/gtk/resources.md b/docs/reference/gtk/resources.md
new file mode 100644 (file)
index 0000000..c2cc2d3
--- /dev/null
@@ -0,0 +1,39 @@
+# Contact information and bug reports {#gtk-resources}
+
+## Opening a bug or feature request
+
+If you encounter a bug, misfeature, or missing feature in GTK, please
+file a bug report on our [GitLab project](https://gitlab.gnome.org/GNOME/gtk/issues/new).
+You should also file issues if the documentation is out of date with the
+existing API, or unclear.
+
+Don't hesitate to file a bug report, even if you think we may know
+about it already, or aren't sure of the details. Just give us as much
+information as you have, and if it's already fixed or has already been
+discussed, we'll add a note to that effect in the report.
+
+The issue tracker should definitely be used for feature requests, it's
+not only for bugs. We track all GTK development in GitLab, to ensure
+that nothing gets lost.
+
+## Working on GTK
+
+If you develop a bugfix or enhancement for GTK, please open a merge
+request in GitLab as well. You should not attach patches to an issue,
+or describe the fix as a comment. Merge requests allow us to build
+GTK with your code applied, and run the test suite, on multiple platforms
+and architectures, and verify that nothing breaks. They also allow us to
+do proper code reviews, so we can iterate over the changes.
+
+You should follow the [contribution guide](https://gitlab.gnome.org/GNOME/gtk/blob/master/CONTRIBUTING.md)
+for GTK, available on GitLab.
+
+If you want to discuss your approach before or after working on it,
+good ways to contact the GTK developers, apart from GitLab issues,
+are
+
+- the #gtk IRC channel on irc.gnome.org
+- the gtk tag on the <[GNOME Discourse instance](https://discourse.gnome.org/tag/gtk)
+
+You should not send patches by email, as they will inevitably get lost,
+or forgotten. Always open a merge request.
diff --git a/docs/reference/gtk/resources.xml b/docs/reference/gtk/resources.xml
deleted file mode 100644 (file)
index 1743708..0000000
+++ /dev/null
@@ -1,76 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-]>
-<refentry id="gtk-resources">
-<refmeta>
-<refentrytitle>Contact information and bug reports</refentrytitle>
-<manvolnum>3</manvolnum>
-<refmiscinfo>Contact information and bug reports</refmiscinfo>
-</refmeta>
-
-<refnamediv>
-<refname>Contact information and bug reports</refname>
-<refpurpose>
-Getting help with GTK
-</refpurpose>
-</refnamediv>
-
-<refsect1>
-<title>Opening a bug or feature request</title>
-
-<para>
-If you encounter a bug, misfeature, or missing feature in GTK, please
-file a bug report on our
-<ulink url="https://gitlab.gnome.org/GNOME/gtk/issues/new">GitLab project</ulink>.
-You should also file issues if the documentation is out of date with the
-existing API, or unclear.
-</para>
-
-<para>
-Don't hesitate to file a bug report, even if you think we may know
-about it already, or aren't sure of the details. Just give us as much
-information as you have, and if it's already fixed or has already been
-discussed, we'll add a note to that effect in the report.
-</para>
-
-<para>
-The issue tracker should definitely be used for feature requests, it's
-not only for bugs. We track all GTK development in GitLab, to ensure
-that nothing gets lost.
-</para>
-
-</refsect1>
-
-<refsect1>
-<title>Working on GTK</title>
-
-<para>
-If you develop a bugfix or enhancement for GTK, please open a merge
-request in GitLab as well. You should not attach patches to an issue,
-or describe the fix as a comment. Merge requests allow us to build
-GTK with your code applied, and run the test suite, on multiple platforms
-and architectures, and verify that nothing breaks. They also allow us to
-do proper code reviews, so we can iterate over the changes.
-</para>
-
-<para>
-You should follow the <ulink url="https://gitlab.gnome.org/GNOME/gtk/blob/master/CONTRIBUTING.md">contribution guide</ulink>
-for GTK, available on GitLab.
-</para>
-
-<para>
-If you want to discuss your approach before or after working on it,
-good ways to contact the GTK developers, apart from GitLab issues,
-are
-<simplelist>
-<member>the #gtk IRC channel on irc.gnome.org</member>
-<member>the gtk tag on the <ulink url="https://discourse.gnome.org/tag/gtk">GNOME Discourse instance</ulink></member>
-</simplelist>
-You should not send patches by email, as they will inevitably get lost,
-or forgotten. Always open a merge request.
-</para>
-
-</refsect1>
-
-</refentry>